pp108 : Creating a Delivery Model

Creating a Delivery Model

This topic describes the procedure to create a delivery model for a task.

Before you begin this task:

Create an XForm or an External User Interface.

Delivery models are used to model the input message for a human interaction activity. The XForms or User Interfaces used as human Interaction activities are based on data models, Web services, or simple freeform controls, that contain the data required for the business process. All the activities in a business process may not require the complete data in the XForm. Process Platform enables you to model or segregate this data through the delivery models. While creating the delivery models, you can select only those models or Web services that are needed for specific activities.

Note:

  • You can create several delivery models on an XForm, and use them on various human interaction activities associated to the same XForm, as per your requirements.
  • For transactional models, you can choose to provide only the unique identifier as the input instead of the entire message. The XForm or User Interface fetches the complete message part from the source.
    Based on the input message, you can also:
    • Create Inbox Models, where you can model the attributes that can be displayed as columns in the Inbox. These attributes can be used as conditions when searching for tasks in the Process Platform Inbox. You can model a maximum of 25 attributes of type String, 5 attributes each of type Integer, Float, Date, and Boolean columns in the Inbox.
    • Create Email Models, where you can model an E-mail message using the attributes and send it to the preferred e-mail addresses of the users.
  • If the response of selected records have to be passed on from the Task in My Inbox to a process instance, you must ensure that the model used to fetch the records is of the type - Transactional.
  1. Right-click the required XForm or External User Interface from the project tree and select Create Delivery Model from the context menu. Alternatively, open the External User Interface, click on the toolbar, and click in the Children - Untitled External User Interface pane. An Untitled Delivery Model - Delivery Model window appears.
  2. Click to select the Operations. The Select Operations window appears displaying the Operations that are used in the XForm along with their namespaces. The window comprises Free-Form Controls which are dragged onto the XForm and do not have binding to any models, Web service Operations, and Dummy models used in the XForm.

    Note: If the Delivery Model is being created on an External User Interface, the Select Operations window displays only the Input Schema.

  3. Select the check box against the required Operations or controls and click Add. The selected operations are displayed in the Messages tab that appears.

    Note: Based on the operations selected in this tab, you can set the task identifiers which will be used to search the tasks in the Inbox and model the messages that will be sent to the users.

  4. In the Pass Data By column, select any of the following:
    • Value - To pass the entire object as the input to the task in the business process. By default, this option is selected.
    • Key - To pass a key, which is a unique identifier of the business object, as the input to the task in the business process. The input criteria is defined for the selected Operations.

      Info:

      • Based on the selection in this column, the data is populated in the Inbox Model, and Email Model tabs.
      • If the Pass Data By is selected as Key, only the unique identifier of the business object is available for selection in the remaining tabs. If the Pass Data By is selected as Value, the complete business object is available for selection.
      • For Dummy models and Free-form controls, only the Value option is available.
  5. To model the task content sent to the Process Platform Inbox, select the Enable Inbox Model check box at the bottom of the screen. For complete procedure, refer to creating an inbox model. The tasks that are sent to My Inbox are modeled in the format defined. 
  6. To model the task content sent to the preferred e-mail ID of the user, select the Enable Email Model check box at the bottom of the screen. For complete procedure, refer to creating an e-mail model. The task content is modeled as defined and will be sent to the e-mail ID of the users.

Note: If response of the selected records have to be passed on from the Task in the My Inbox to the process instance, ensure that the model used to fetch the records is of the type Transactional. The non-transactional models must not be used in the User Interface when it is needed to pass on the selected record details to the process instance.

The Delivery Model is created.

 

After you complete this task:

Right-click the delivery model in the project tree and select Publish to Organization. The delivery model will now be available and can be selected from the property pane of the selected activity in a process.

When a Delivery Model is published, the associated Inbox Model and E-mail Model are also published. While publishing or deploying the Delivery Model, the notification service will re-index task data for all the tasks associated with the Inbox model. This action ensures that all the task data is indexed properly as per the new Inbox Model. This action is done in the back ground. My Inbox will not show the data in the business attribute columns until this re-indexing is completed.

Related tasks

Creating a User Interface Using a Web Page URL